home *** CD-ROM | disk | FTP | other *** search
/ Game Programming in C++ - Start to Finish / GameProgrammingS.iso / developer_install / CEGUISDK-0.4.1-VC6-Native.exe / {app} / include / elements / CEGUISliderProperties.h < prev    next >
Encoding:
C/C++ Source or Header  |  2005-01-18  |  3.4 KB  |  123 lines
  1. /************************************************************************
  2.     filename:     CEGUISliderProperties.h
  3.     created:    10/7/2004
  4.     author:        Paul D Turner
  5.     
  6.     purpose:    Interface to properties for Slider class
  7. *************************************************************************/
  8. /*************************************************************************
  9.     Crazy Eddie's GUI System (http://www.cegui.org.uk)
  10.     Copyright (C)2004 - 2005 Paul D Turner (paul@cegui.org.uk)
  11.  
  12.     This library is free software; you can redistribute it and/or
  13.     modify it under the terms of the GNU Lesser General Public
  14.     License as published by the Free Software Foundation; either
  15.     version 2.1 of the License, or (at your option) any later version.
  16.  
  17.     This library is distributed in the hope that it will be useful,
  18.     but WITHOUT ANY WARRANTY; without even the implied warranty of
  19.     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20.     Lesser General Public License for more details.
  21.  
  22.     You should have received a copy of the GNU Lesser General Public
  23.     License along with this library; if not, write to the Free Software
  24.     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  25. *************************************************************************/
  26. #ifndef _CEGUISliderProperties_h_
  27. #define _CEGUISliderProperties_h_
  28.  
  29. #include "CEGUIProperty.h"
  30.  
  31.  
  32. // Start of CEGUI namespace section
  33. namespace CEGUI
  34. {
  35.  
  36. // Start of SliderProperties namespace section
  37. /*!
  38. \brief
  39.     Namespace containing all classes that make up the properties interface for the Slider class
  40. */
  41. namespace SliderProperties
  42. {
  43. /*!
  44. \brief
  45.     Property to access the current value of the slider.
  46.  
  47.     \par Usage:
  48.         - Name: CurrentValue
  49.         - Format: "[float]".
  50.  
  51.     \par Where:
  52.         - [float] represents the current value of the slider.
  53. */
  54. class CurrentValue : public Property
  55. {
  56. public:
  57.     CurrentValue() : Property(
  58.         "CurrentValue",
  59.         "Property to get/set the current value of the slider.  Value is a float.",
  60.         "0.000000")
  61.     {}
  62.  
  63.     String    get(const PropertyReceiver* receiver) const;
  64.     void    set(PropertyReceiver* receiver, const String& value);
  65. };
  66.  
  67.  
  68. /*!
  69. \brief
  70.     Property to access the maximum value of the slider.
  71.  
  72.     \par Usage:
  73.         - Name: MaximumValue
  74.         - Format: "[float]".
  75.  
  76.     \par Where:
  77.         - [float] represents the maximum value of the slider.
  78. */
  79. class MaximumValue : public Property
  80. {
  81. public:
  82.     MaximumValue() : Property(
  83.         "MaximumValue",
  84.         "Property to get/set the maximum value of the slider.  Value is a float.",
  85.         "1.000000")
  86.     {}
  87.  
  88.     String    get(const PropertyReceiver* receiver) const;
  89.     void    set(PropertyReceiver* receiver, const String& value);
  90. };
  91.  
  92.  
  93. /*!
  94. \brief
  95.     Property to access the click-step size for the slider.
  96.  
  97.     \par Usage:
  98.         - Name: ClickStepSize
  99.         - Format: "[float]".
  100.  
  101.     \par Where:
  102.         - [float] represents the click-step size slider (this is how much the value changes when the slider container is clicked).
  103. */
  104. class ClickStepSize : public Property
  105. {
  106. public:
  107.     ClickStepSize() : Property(
  108.         "ClickStepSize",
  109.         "Property to get/set the click-step size for the slider.  Value is a float.",
  110.         "0.010000")
  111.     {}
  112.  
  113.     String    get(const PropertyReceiver* receiver) const;
  114.     void    set(PropertyReceiver* receiver, const String& value);
  115. };
  116.  
  117. } // End of  SliderProperties namespace section
  118.  
  119. } // End of  CEGUI namespace section
  120.  
  121.  
  122. #endif    // end of guard _CEGUISliderProperties_h_
  123.